<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Module: pdfjsLib</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Module: pdfjsLib</h1>

    




<section>

<header>
    
        
    
</header>

<article>
    <div class="container-overview">
    
        

        
    
    </div>

    

    

    
        <h3 class="subsection-title">Classes</h3>

        <dl>
            <dt><a href="module-pdfjsLib-PDFDataRangeTransport.html">PDFDataRangeTransport</a></dt>
            <dd></dd>
        
            <dt><a href="module-pdfjsLib-PDFDocumentLoadingTask.html">PDFDocumentLoadingTask</a></dt>
            <dd></dd>
        
            <dt><a href="module-pdfjsLib-PDFDocumentProxy.html">PDFDocumentProxy</a></dt>
            <dd></dd>
        
            <dt><a href="module-pdfjsLib-PDFObjects.html">PDFObjects</a></dt>
            <dd></dd>
        
            <dt><a href="module-pdfjsLib-PDFPageProxy.html">PDFPageProxy</a></dt>
            <dd></dd>
        
            <dt><a href="module-pdfjsLib-PDFWorker.html">PDFWorker</a></dt>
            <dd></dd>
        
            <dt><a href="module-pdfjsLib-RenderTask.html">RenderTask</a></dt>
            <dd></dd>
        </dl>
    

    

    

    

    
        <h3 class="subsection-title">Members</h3>

        
            
<h4 class="name" id="~build"><span class="type-signature">(inner, constant) </span>build<span class="type-signature"> :string</span></h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line3335">line 3335</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
            
<h4 class="name" id="~version"><span class="type-signature">(inner, constant) </span>version<span class="type-signature"> :string</span></h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line3332">line 3332</a>
    </li></ul></dd>
    

    

    

    
</dl>






        
    

    
        <h3 class="subsection-title">Methods</h3>

        
            

    

    
    <h4 class="name" id="~getDocument"><span class="type-signature">(inner) </span>getDocument<span class="signature">(src)</span><span class="type-signature"> &rarr; {PDFDocumentLoadingTask}</span></h4>
    

    



<div class="description">
    This is the main entry point for loading a PDF and interacting with it.

NOTE: If a URL is used to fetch the PDF data a standard Fetch API call (or
XHR as fallback) is used, which means it must follow same origin rules,
e.g. no cross-domain requests without CORS.
</div>









    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>src</code></td>
            

            <td class="type">
            
                
<span class="param-type">GetDocumentParameters</span>


            
            </td>

            

            

            <td class="description last">Can be a URL where a PDF file is located, a typed array (Uint8Array)
        already populated with data, or a parameter object.</td>
        </tr>

    
    </tbody>
</table>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line242">line 242</a>
    </li></ul></dd>
    

    

    

    
</dl>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">PDFDocumentLoadingTask</span>


    </dd>
</dl>

    





        
    

    
        <h3 class="subsection-title">Type Definitions</h3>

        
                
<h4 class="name" id="~BinaryData">BinaryData</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">TypedArray</span>
|

<span class="param-type">ArrayBuffer</span>
|

<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>
|

<span class="param-type">string</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line120">line 120</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~DocumentInitParameters">DocumentInitParameters</h4>




<div class="description">
    Document initialization / loading parameters object.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">URL</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The URL of the PDF.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>data</code></td>
            

            <td class="type">
            
                
<span class="param-type">BinaryData</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Binary PDF data.
  Use typed arrays (Uint8Array) to improve the memory usage. If PDF data is
  BASE64-encoded, use `atob()` to convert it to a binary string first.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>httpHeaders</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Basic authentication headers.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>withCredentials</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Indicates whether or not
  cross-site Access-Control requests should be made using credentials such
  as cookies or authorization headers. The default is `false`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>password</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">For decrypting password-protected PDFs.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>initialData</code></td>
            

            <td class="type">
            
                
<span class="param-type">TypedArray</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">A typed array with the first portion
  or all of the pdf data. Used by the extension since some data is already
  loaded before the switch to range requests.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>length</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The PDF file length. It's used for progress
  reports and range requests operations.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>range</code></td>
            

            <td class="type">
            
                
<span class="param-type">PDFDataRangeTransport</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Allows for using a custom range
  transport implementation.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>rangeChunkSize</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Specify maximum number of bytes fetched
  per range request. The default value is DEFAULT_RANGE_CHUNK_SIZE.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>worker</code></td>
            

            <td class="type">
            
                
<span class="param-type">PDFWorker</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The worker that will be used for loading and
  parsing the PDF data.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>verbosity</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Controls the logging level; the constants
  from VerbosityLevel should be used.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>docBaseUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The base URL of the document, used when
  attempting to recover valid absolute URLs for annotations, and outline
  items, that (incorrectly) only specify relative URLs.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>cMapUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The URL where the predefined Adobe CMaps are
  located. Include the trailing slash.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>cMapPacked</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Specifies if the Adobe CMaps are binary
  packed or not.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>CMapReaderFactory</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The factory that will be used when
  reading built-in CMap files. Providing a custom factory is useful for
  environments without Fetch API or `XMLHttpRequest` support, such as
  Node.js. The default value is {DOMCMapReaderFactory}.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>useSystemFonts</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">When `true`, fonts that aren't
  embedded in the PDF document will fallback to a system font.
  The default value is `true` in web environments and `false` in Node.js;
  unless `disableFontFace === true` in which case this defaults to `false`
  regardless of the environment (to prevent completely broken fonts).</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>standardFontDataUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The URL where the standard font
  files are located. Include the trailing slash.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>StandardFontDataFactory</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The factory that will be used
  when reading the standard font files. Providing a custom factory is useful
  for environments without Fetch API or `XMLHttpRequest` support, such as
  Node.js. The default value is {DOMStandardFontDataFactory}.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>useWorkerFetch</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Enable using the Fetch API in the
  worker-thread when reading CMap and standard font files. When `true`,
  the `CMapReaderFactory` and `StandardFontDataFactory` options are ignored.
  The default value is `true` in web environments and `false` in Node.js.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>stopAtErrors</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Reject certain promises, e.g.
  `getOperatorList`, `getTextContent`, and `RenderTask`, when the associated
  PDF data cannot be successfully parsed, instead of attempting to recover
  whatever possible of the data. The default value is `false`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>maxImageSize</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The maximum allowed image size in total
  pixels, i.e. width * height. Images above this value will not be rendered.
  Use -1 for no limit, which is also the default value.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>isEvalSupported</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Determines if we can evaluate strings
  as JavaScript. Primarily used to improve performance of font rendering, and
  when parsing PDF functions. The default value is `true`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableFontFace</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">By default fonts are converted to
  OpenType fonts and loaded via the Font Loading API or `@font-face` rules.
  If disabled, fonts will be rendered using a built-in font renderer that
  constructs the glyphs with primitive path commands.
  The default value is `false` in web environments and `true` in Node.js.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fontExtraProperties</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Include additional properties,
  which are unused during rendering of PDF documents, when exporting the
  parsed font data from the worker-thread. This may be useful for debugging
  purposes (and backwards compatibility), but note that it will lead to
  increased memory usage. The default value is `false`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>enableXfa</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Render Xfa forms if any.
  The default value is `false`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>ownerDocument</code></td>
            

            <td class="type">
            
                
<span class="param-type">HTMLDocument</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Specify an explicit document
  context to create elements with and to load resources, such as fonts,
  into. Defaults to the current document.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableRange</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Disable range request loading of PDF
  files. When enabled, and if the server supports partial content requests,
  then the PDF will be fetched in chunks. The default value is `false`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableStream</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Disable streaming of PDF file data.
  By default PDF.js attempts to load PDF files in chunks. The default value
  is `false`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>disableAutoFetch</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Disable pre-fetching of PDF file
  data. When range requests are enabled PDF.js will automatically keep
  fetching more data even if it isn't needed to display the current page.
  The default value is `false`.

  NOTE: It is also necessary to disable streaming, see above, in order for
  disabling of pre-fetching to work correctly.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pdfBug</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Enables special hooks for debugging PDF.js
  (see `web/debugger.js`). The default value is `false`.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line130">line 130</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~GetAnnotationsParameters">GetAnnotationsParameters</h4>




<div class="description">
    Page annotation parameters.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>intent</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Determines the annotations that are fetched,
  can be 'display' (viewable annotations), 'print' (printable annotations),
  or 'any' (all annotations). The default value is 'display'.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1112">line 1112</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~GetDocumentParameters">GetDocumentParameters</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">string</span>
|

<span class="param-type">URL</span>
|

<span class="param-type">TypedArray</span>
|

<span class="param-type">ArrayBuffer</span>
|

<span class="param-type">PDFDataRangeTransport</span>
|

<span class="param-type">DocumentInitParameters</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line224">line 224</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~GetOperatorListParameters">GetOperatorListParameters</h4>




<div class="description">
    Page getOperatorList parameters.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>intent</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Rendering intent, can be 'display', 'print',
  or 'any'. The default value is 'display'.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>annotationMode</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Controls which annotations are included
  in the operatorList, for annotations with appearance-data; the values from
  AnnotationMode should be used. The following values are supported:
   - `AnnotationMode.DISABLE`, which disables all annotations.
   - `AnnotationMode.ENABLE`, which includes all possible annotations (thus
     it also depends on the `intent`-option, see above).
   - `AnnotationMode.ENABLE_FORMS`, which excludes annotations that contain
     interactive form elements (those will be rendered in the display layer).
   - `AnnotationMode.ENABLE_STORAGE`, which includes all possible annotations
     (as above) but where interactive form elements are updated with data
     from the AnnotationStorage-instance; useful e.g. for printing.
  The default value is `AnnotationMode.ENABLE`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>printAnnotationStorage</code></td>
            

            <td class="type">
            
                
<span class="param-type">PrintAnnotationStorage</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1167">line 1167</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~getTextContentParameters">getTextContentParameters</h4>




<div class="description">
    Page getTextContent parameters.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>disableCombineTextItems</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">Do not attempt to combine
  same line TextItem's. The default value is `false`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>includeMarkedContent</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">When true include marked
  content items in the items array of TextContent. The default is `false`.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1057">line 1057</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~GetViewportParameters">GetViewportParameters</h4>




<div class="description">
    Page getViewport parameters.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>scale</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">The desired scale of the viewport.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>rotation</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The desired rotation, in degrees, of
  the viewport. If omitted it defaults to the page rotation.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetX</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The horizontal, i.e. x-axis, offset.
  The default value is `0`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>offsetY</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The vertical, i.e. y-axis, offset.
  The default value is `0`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dontFlip</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">If true, the y-axis will not be
  flipped. The default value is `false`.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1042">line 1042</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~MarkInfo">MarkInfo</h4>




<div class="description">
    Properties correspond to Table 321 of the PDF 32000-1:2008 spec.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>Marked</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>UserProperties</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>Suspects</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line935">line 935</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~OnProgressParameters">OnProgressParameters</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>loaded</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">Currently loaded number of bytes.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>total</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">Total number of bytes in the PDF file.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line541">line 541</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~OutlineNode">OutlineNode</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>title</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>bold</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>italic</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">Uint8ClampedArray</span>


            
            </td>

            

            

            <td class="description last">The color in RGB format to use for
  display purposes.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dest</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>
|

<span class="param-type">null</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>url</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">null</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>unsafeUrl</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>
|

<span class="param-type">undefined</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>newWindow</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>
|

<span class="param-type">undefined</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>count</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>
|

<span class="param-type">undefined</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>items</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;OutlineNode:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line883">line 883</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~PDFDocumentStats">PDFDocumentStats</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>streamTypes</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, boolean:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            

            

            <td class="description last">Used stream types in the
  document (an item is set to true if specific stream ID was used in the
  document).</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fontTypes</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, boolean:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            

            

            <td class="description last">Used font types in the
  document (an item is set to true if specific font ID was used in the
  document).</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line739">line 739</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~PDFOperatorList">PDFOperatorList</h4>




<div class="description">
    PDF page operator list.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>fnArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;number:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            

            

            <td class="description last">Array containing the operator functions.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>argsArray</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            

            

            <td class="description last">Array containing the arguments of the
  functions.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1207">line 1207</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~PDFWorkerParameters">PDFWorkerParameters</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The name of the worker.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>port</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The `workerPort` object.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>verbosity</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Controls the logging level;
  the constants from VerbosityLevel should be used.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1887">line 1887</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~RefProxy">RefProxy</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>num</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>gen</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line124">line 124</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~RenderParameters">RenderParameters</h4>




<div class="description">
    Page render parameters.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>canvasContext</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">A 2D context of a DOM Canvas object.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>viewport</code></td>
            

            <td class="type">
            
                
<span class="param-type">PageViewport</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last">Rendering viewport obtained by calling
  the `PDFPageProxy.getViewport` method.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>intent</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Rendering intent, can be 'display', 'print',
  or 'any'. The default value is 'display'.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>annotationMode</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Controls which annotations are rendered
  onto the canvas, for annotations with appearance-data; the values from
  AnnotationMode should be used. The following values are supported:
   - `AnnotationMode.DISABLE`, which disables all annotations.
   - `AnnotationMode.ENABLE`, which includes all possible annotations (thus
     it also depends on the `intent`-option, see above).
   - `AnnotationMode.ENABLE_FORMS`, which excludes annotations that contain
     interactive form elements (those will be rendered in the display layer).
   - `AnnotationMode.ENABLE_STORAGE`, which includes all possible annotations
     (as above) but where interactive form elements are updated with data
     from the AnnotationStorage-instance; useful e.g. for printing.
  The default value is `AnnotationMode.ENABLE`.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>transform</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Additional transform, applied just
  before viewport transform.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>canvasFactory</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">The factory instance that will be used
  when creating canvases. The default value is {new DOMCanvasFactory()}.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>background</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>
|

<span class="param-type">string</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Background to use for the canvas.
  Any valid `canvas.fillStyle` can be used: a `DOMString` parsed as CSS
  <color> value, a `CanvasGradient` object (a linear or radial gradient) or
  a `CanvasPattern` object (a repetitive image). The default value is
  'rgb(255,255,255)'.

  NOTE: This option may be partially, or completely, ignored when the
  `pageColors`-option is used.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>pageColors</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Overwrites background and foreground colors
  with user defined ones in order to improve readability in high contrast
  mode.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>optionalContentConfigPromise</code></td>
            

            <td class="type">
            
                
<span class="param-type">Promise:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;OptionalContentConfig:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">A promise that should resolve with an OptionalContentConfig
  created from `PDFDocumentProxy.getOptionalContentConfig`. If `null`,
  the configuration will be fetched automatically with the default visibility
  states set.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>annotationCanvasMap</code></td>
            

            <td class="type">
            
                
<span class="param-type">Map:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, HTMLCanvasElement:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last">Map some
  annotation ids with canvases used to render them.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>printAnnotationStorage</code></td>
            

            <td class="type">
            
                
<span class="param-type">PrintAnnotationStorage</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"></td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1121">line 1121</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~StructTreeContent">StructTreeContent</h4>




<div class="description">
    Structure tree content.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">either "content" for page and stream structure
  elements or "object" for object references.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">unique id that will map to the text layer.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1198">line 1198</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~StructTreeNode">StructTreeNode</h4>




<div class="description">
    Structure tree node. The root node will have a role "Root".
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>children</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(StructTreeNode:<a href="module-pdfjsLib-PDFObjects.html"></a>|StructTreeContent:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


            
            </td>

            

            

            <td class="description last">Array of
  StructTreeNode and StructTreeContent objects.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>role</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">element's role, already mapped if a role map exists
in the PDF.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1188">line 1188</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~TextContent">TextContent</h4>




<div class="description">
    Page text content.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>items</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;(TextItem:<a href="module-pdfjsLib-PDFObjects.html"></a>|TextMarkedContent:<a href="module-pdfjsLib-PDFObjects.html"></a>)></span>


            
            </td>

            

            

            <td class="description last">Array of
  TextItem and TextMarkedContent objects. TextMarkedContent
  items are included when includeMarkedContent is true.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>styles</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;string:<a href="module-pdfjsLib-PDFObjects.html"></a>, TextStyle:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            

            

            <td class="description last">TextStyle objects,
  indexed by font name.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1067">line 1067</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~TextItem">TextItem</h4>




<div class="description">
    Page text content part.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>str</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">Text content.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>dir</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">Text direction: 'ttb', 'ltr' or 'rtl'.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>transform</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array:<a href="module-pdfjsLib-PDFObjects.html"></a>.&lt;any:<a href="module-pdfjsLib-PDFObjects.html"></a>></span>


            
            </td>

            

            

            <td class="description last">Transformation matrix.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">Width in device space.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">Height in device space.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fontName</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">Font name used by PDF.js for converted font.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>hasEOL</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">Indicating if the text content is followed by a
  line-break.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1078">line 1078</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~TextMarkedContent">TextMarkedContent</h4>




<div class="description">
    Page text marked content part.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">Either 'beginMarkedContent',
  'beginMarkedContentProps', or 'endMarkedContent'.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">The marked content identifier. Only used for type
  'beginMarkedContentProps'.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1092">line 1092</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~TextStyle">TextStyle</h4>




<div class="description">
    Text style.
</div>



    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h5 class="subsection-title">Properties:</h5>

    

<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ascent</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">Font ascent.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>descent</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            
            </td>

            

            

            <td class="description last">Font descent.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>vertical</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            
            </td>

            

            

            <td class="description last">Whether or not the text is in vertical mode.</td>
        </tr>

    

        <tr>
            
                <td class="name"><code>fontFamily</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            
            </td>

            

            

            <td class="description last">The possible font family.</td>
        </tr>

    
    </tbody>
</table>




<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line1102">line 1102</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
                
<h4 class="name" id="~TypedArray">TypedArray</h4>






    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Int8Array</span>
|

<span class="param-type">Uint8Array</span>
|

<span class="param-type">Uint8ClampedArray</span>
|

<span class="param-type">Int16Array</span>
|

<span class="param-type">Uint16Array</span>
|

<span class="param-type">Int32Array</span>
|

<span class="param-type">Uint32Array</span>
|

<span class="param-type">Float32Array</span>
|

<span class="param-type">Float64Array</span>


        </li>
    </ul>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="api.js.html">api.js</a>, <a href="api.js.html#line112">line 112</a>
    </li></ul></dd>
    

    

    

    
</dl>






            
    

    
</article>

</section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-pdfjsLib.html">pdfjsLib</a></li></ul><h3>Classes</h3><ul><li><a href="module-pdfjsLib-PDFDataRangeTransport.html">PDFDataRangeTransport</a></li><li><a href="module-pdfjsLib-PDFDocumentLoadingTask.html">PDFDocumentLoadingTask</a></li><li><a href="module-pdfjsLib-PDFDocumentProxy.html">PDFDocumentProxy</a></li><li><a href="module-pdfjsLib-PDFObjects.html">PDFObjects</a></li><li><a href="module-pdfjsLib-PDFPageProxy.html">PDFPageProxy</a></li><li><a href="module-pdfjsLib-PDFWorker.html">PDFWorker</a></li><li><a href="module-pdfjsLib-RenderTask.html">RenderTask</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Sep 07 2022 09:51:15 GMT+0000 (Coordinated Universal Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>